Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Documentation] Added raw hid documentation page #7640

Merged
merged 18 commits into from
May 1, 2020
Merged

[Documentation] Added raw hid documentation page #7640

merged 18 commits into from
May 1, 2020

Conversation

ash0x0
Copy link
Contributor

@ash0x0 ash0x0 commented Dec 15, 2019

Description

Added feature documentation page for raw HID.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

None.

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

fauxpark
fauxpark requested changes Dec 15, 2019
View reviewed changes
docs/feature_rawhid.md Outdated Show resolved Hide resolved
docs/feature_rawhid.md Outdated Show resolved Hide resolved
docs/feature_rawhid.md Outdated Show resolved Hide resolved
docs/feature_rawhid.md Outdated Show resolved Hide resolved
docs/features.md Outdated Show resolved Hide resolved
docs/feature_rawhid.md Outdated Show resolved Hide resolved
fauxpark
fauxpark reviewed Dec 16, 2019
View reviewed changes
docs/_summary.md Outdated Show resolved Hide resolved
fauxpark
fauxpark reviewed Dec 16, 2019
View reviewed changes
docs/feature_rawhid.md Outdated Show resolved Hide resolved
ash0x0 and others added 2 commits December 16, 2019 02:45
@ash0x0 @fauxpark
Update docs/feature_rawhid.md
66a66a0 
Co-Authored-By: fauxpark <[email protected]>
@ash0x0
Update feature_rawhid.md
e48fa59 
Removed the useless bit about finding usage page and usage.
fauxpark
fauxpark reviewed Dec 16, 2019
View reviewed changes
docs/feature_rawhid.md Outdated Show resolved Hide resolved
@drashna drashna requested a review from a team December 16, 2019 05:27
@tzarc
Copy link
Member

tzarc commented Jan 27, 2020

Just an FYI: hidapi got moved to https://github.com/libusb/hidapi

@stale
Copy link

stale bot commented Mar 12, 2020

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

@stale
Copy link

stale bot commented Apr 11, 2020

Thank you for your contribution!
This pull request has been automatically closed because it has not had activity in the last 30 days. Please feel free to give a status update now, ping for review, or re-open when it's ready.

@stale stale bot closed this Apr 11, 2020
@tzarc tzarc reopened this Apr 12, 2020
@stale stale bot removed the awaiting changes label Apr 12, 2020
tzarc
tzarc requested changes Apr 12, 2020
View reviewed changes
Copy link
Member

@tzarc tzarc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got some conflicts, too.

docs/feature_rawhid.md Outdated Show resolved Hide resolved
docs/feature_rawhid.md Outdated Show resolved Hide resolved
docs/feature_rawhid.md Outdated Show resolved Hide resolved
docs/feature_rawhid.md Outdated Show resolved Hide resolved
@tzarc tzarc requested a review from a team April 12, 2020 01:05
ash0x0 and others added 4 commits April 12, 2020 20:20
@ash0x0 ash0x0 requested review from tzarc and fauxpark and removed request for a team April 12, 2020 18:40
@tzarc tzarc mentioned this pull request Apr 18, 2020
Merged
13 tasks
@drashna
Copy link
Member

drashna commented Apr 28, 2020

2 things here:

  1. THere are merge conflicts that need to be resolved. Additionally the documents part has been changed significantly, so it needs some updating, too.
  2. @fauxpark had a raw hid example, too. IIRC

ash0x0 added 3 commits April 28, 2020 20:53
@ash0x0
Fixed merge conflicts
f0d48a4 
Removed features.md
Updated _summary.md with new format and added RAW HID entry under Software Features
@ash0x0
Merge branch 'master' into documentation_merge
e1eeab5
@ash0x0
Added rawhid feature page
2adb502 
Messy is what you get when you don't do things right the first time
@ash0x0
Copy link
Contributor Author

ash0x0 commented Apr 28, 2020 •
edited
Loading

@tzarc If I understand #8834 correctly, the documentation needs to be changed to reflect that the user should check configs to see if RAW_USAGE_PAGE or RAW_USAGE_ID are defined and if not they default to 0xFF60 and 0x61 respectively. Correct?
@drashna fixed the conflicts. I can't find the example you referenced from @fauxpark.
EDIT: Does Raw HID belong under Software Features in summary?

@tzarc
Copy link
Member

tzarc commented Apr 28, 2020

@ash0x0 you can ignore that PR for the moment, I'll update things accordingly.

@tzarc
Copy link
Member

tzarc commented Apr 28, 2020

EDIT: Does Raw HID belong under Software Features in summary?

I don't really see anywhere better in the current list... should be fine.

@tzarc tzarc requested a review from a team April 28, 2020 19:25
@tzarc tzarc merged commit 750c7c2 into qmk:master May 1, 2020
violet-fish pushed a commit to violet-fish/qmk_firmware that referenced this pull request May 3, 2020
@ash0x0 @fauxpark
@tzarc @violet-fish
[Documentation] Added raw hid documentation page (qmk#7640)
f2872ec 
* Added raw hid feature documentation page

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/features.md

Co-Authored-By: fauxpark <[email protected]>

* added feature_rawhid.md to _summary.md in docs

* fixed _summary.md order

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update feature_rawhid.md

Removed the useless bit about finding usage page and usage.

* Update feature_rawhid.md

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Remove teensy client, small origanization fixes

* Fixed merge conflicts
Removed features.md
Updated _summary.md with new format and added RAW HID entry under Software Features

* Added rawhid feature page
Messy is what you get when you don't do things right the first time

Co-authored-by: fauxpark <[email protected]>
Co-authored-by: Nick Brassel <[email protected]>
bitherder pushed a commit to bitherder/qmk_firmware that referenced this pull request May 15, 2020
@ash0x0 @fauxpark
@tzarc @lorenzoernesto
[Documentation] Added raw hid documentation page (qmk#7640)
55bcd8c 
* Added raw hid feature documentation page

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/features.md

Co-Authored-By: fauxpark <[email protected]>

* added feature_rawhid.md to _summary.md in docs

* fixed _summary.md order

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update feature_rawhid.md

Removed the useless bit about finding usage page and usage.

* Update feature_rawhid.md

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Remove teensy client, small origanization fixes

* Fixed merge conflicts
Removed features.md
Updated _summary.md with new format and added RAW HID entry under Software Features

* Added rawhid feature page
Messy is what you get when you don't do things right the first time

Co-authored-by: fauxpark <[email protected]>
Co-authored-by: Nick Brassel <[email protected]>
sowbug pushed a commit to sowbug/qmk_firmware that referenced this pull request May 24, 2020
@ash0x0 @fauxpark
@tzarc @sowbug
[Documentation] Added raw hid documentation page (qmk#7640)
a07fa13 
* Added raw hid feature documentation page

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/features.md

Co-Authored-By: fauxpark <[email protected]>

* added feature_rawhid.md to _summary.md in docs

* fixed _summary.md order

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update feature_rawhid.md

Removed the useless bit about finding usage page and usage.

* Update feature_rawhid.md

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Remove teensy client, small origanization fixes

* Fixed merge conflicts
Removed features.md
Updated _summary.md with new format and added RAW HID entry under Software Features

* Added rawhid feature page
Messy is what you get when you don't do things right the first time

Co-authored-by: fauxpark <[email protected]>
Co-authored-by: Nick Brassel <[email protected]>
turky pushed a commit to turky/qmk_firmware that referenced this pull request Jun 13, 2020
@ash0x0 @fauxpark
@tzarc @turky
[Documentation] Added raw hid documentation page (qmk#7640)
36ac974 
* Added raw hid feature documentation page

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/features.md

Co-Authored-By: fauxpark <[email protected]>

* added feature_rawhid.md to _summary.md in docs

* fixed _summary.md order

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update feature_rawhid.md

Removed the useless bit about finding usage page and usage.

* Update feature_rawhid.md

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Remove teensy client, small origanization fixes

* Fixed merge conflicts
Removed features.md
Updated _summary.md with new format and added RAW HID entry under Software Features

* Added rawhid feature page
Messy is what you get when you don't do things right the first time

Co-authored-by: fauxpark <[email protected]>
Co-authored-by: Nick Brassel <[email protected]>
jakobaa pushed a commit to jakobaa/qmk_firmware that referenced this pull request Jul 7, 2020
@ash0x0 @fauxpark
@tzarc @jakobaa
[Documentation] Added raw hid documentation page (qmk#7640)
fa8da34 
* Added raw hid feature documentation page

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/features.md

Co-Authored-By: fauxpark <[email protected]>

* added feature_rawhid.md to _summary.md in docs

* fixed _summary.md order

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update feature_rawhid.md

Removed the useless bit about finding usage page and usage.

* Update feature_rawhid.md

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Remove teensy client, small origanization fixes

* Fixed merge conflicts
Removed features.md
Updated _summary.md with new format and added RAW HID entry under Software Features

* Added rawhid feature page
Messy is what you get when you don't do things right the first time

Co-authored-by: fauxpark <[email protected]>
Co-authored-by: Nick Brassel <[email protected]>
sjmacneil pushed a commit to sjmacneil/qmk_firmware that referenced this pull request Feb 19, 2021
@ash0x0 @fauxpark
@tzarc @sjmacneil
[Documentation] Added raw hid documentation page (qmk#7640)
3709391 
* Added raw hid feature documentation page

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/features.md

Co-Authored-By: fauxpark <[email protected]>

* added feature_rawhid.md to _summary.md in docs

* fixed _summary.md order

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update feature_rawhid.md

Removed the useless bit about finding usage page and usage.

* Update feature_rawhid.md

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Remove teensy client, small origanization fixes

* Fixed merge conflicts
Removed features.md
Updated _summary.md with new format and added RAW HID entry under Software Features

* Added rawhid feature page
Messy is what you get when you don't do things right the first time

Co-authored-by: fauxpark <[email protected]>
Co-authored-by: Nick Brassel <[email protected]>
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
@ash0x0 @fauxpark @tzarc
[Documentation] Added raw hid documentation page (qmk#7640)
f59fa4c 
* Added raw hid feature documentation page

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update docs/features.md

Co-Authored-By: fauxpark <[email protected]>

* added feature_rawhid.md to _summary.md in docs

* fixed _summary.md order

* Update docs/feature_rawhid.md

Co-Authored-By: fauxpark <[email protected]>

* Update feature_rawhid.md

Removed the useless bit about finding usage page and usage.

* Update feature_rawhid.md

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Update docs/feature_rawhid.md

Co-Authored-By: Nick Brassel <[email protected]>

* Remove teensy client, small origanization fixes

* Fixed merge conflicts
Removed features.md
Updated _summary.md with new format and added RAW HID entry under Software Features

* Added rawhid feature page
Messy is what you get when you don't do things right the first time

Co-authored-by: fauxpark <[email protected]>
Co-authored-by: Nick Brassel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Erovia Erovia Erovia left review comments

@tzarc tzarc tzarc approved these changes

@drashna drashna drashna approved these changes

@fauxpark fauxpark Awaiting requested review from fauxpark

Assignees
No one assigned
Labels
awaiting review documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ash0x0 @tzarc @drashna @Erovia @fauxpark